From e59171aab00e6fb939a9fcbdcabacae27492d32c Mon Sep 17 00:00:00 2001 From: Doug Goldstein Date: Sat, 17 Feb 2018 22:41:32 -0600 Subject: [PATCH] update contributing to show how to build the docs The contributing guide referenced a script that was deleted in 1271bb4de0c0 so it wasn't possible to follow the contributing guide successfully prior to contributing doc improvements. --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb7374ee6..ed260e51a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -109,13 +109,16 @@ and [merges][mergequeue] it into Cargo's `master` branch. To contribute to the documentation, all you need to do is change the markdown files in the `src/doc` directory. To view the rendered version of changes you -have made locally, run: +have made locally, make sure you have `mdbook` installed and run: ```sh -sh src/ci/dox.sh -open target/doc/index.html +cd src/doc +mdbook build +open book/index.html ``` +To install `mdbook` run `cargo install mdbook`. + ## Issue Triage -- 2.30.2